help-version

help-version

Automatic handling of --help and --version arguments for CLI applications.

Example

#!/usr/bin/env node

var helpVersion = require('help-version')(usage());

function usage() {
  return 'Usage:  my-app [file]';
}

helpVersion.version()
//=> "v0.1.0"

console.log('main thing');

Catches --help and --version automatically.

$ ./app.js --help
Usage:  my-app [file]
$ ./app.js --version
v0.1.0
$ ./app.js
main thing

API

helpVersion = require('help-version')(help, [version])

Checks process.argv for --help or --version, prints help or version if found one.

version defaults to version field from your local package.json.

helpVersion.help([code], [stream])

With no arguments, returns the help string.

With one or two arguments, writes help to the stream and exits with code. stream defaults to process.stdout if code==0 and process.stderr otherwise.

helpVersion.version([code], [stream])

Returns version string or writes it to stream and exits.

Install

npm install help-version

License

MIT